docs(okp): add RH_SERVER_OKP and change recommended OKP port to 8081#1623
Conversation
WalkthroughA documentation update that changes the OKP Solr container host port from 8983 to 8081, updates all related verification URLs, introduces an environment variable Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~5 minutes 🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (2)
docs/okp_guide.md (2)
45-46:⚠️ Potential issue | 🟡 MinorPrototype image ETA is date-specific and likely stale.
Line [45] says the official OKP RAG image is “expected in late March / early April 2026.” Given this PR’s date context (2026-04-28), that statement may now be outdated and could undermine trust in the guide. Consider updating the timeframe to a less date-sensitive phrasing (or remove it entirely).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 45 - 46, Update the date-specific warning sentence that currently reads "**Warning:** The image referenced below is a **prototype**. The official OKP RAG image is expected in **late March / early April** of 2026." to a non-time-specific phrasing (or remove the ETA) so it doesn't become stale; locate that exact warning sentence in docs/okp_guide.md and replace the ETA clause with a generic statement such as "The official OKP RAG image will be released later; this is a prototype" or simply keep the prototype warning without an expected date.
49-75:⚠️ Potential issue | 🟡 MinorFix inconsistent environment variable reference in the note.
The note at line 64 mentions "you can set the
SOLR_URLenvironment variable" but the actual codebase usesRH_SERVER_OKPas the environment variable (line 74 example and throughout configuration). Update the note to referenceRH_SERVER_OKPinstead ofSOLR_URLto avoid confusion. Port8983references have been verified as removed.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/okp_guide.md` around lines 49 - 75, The note incorrectly refers to SOLR_URL while the project uses RH_SERVER_OKP; update the explanatory note to instruct users to set RH_SERVER_OKP (not SOLR_URL) prior to launching the Lightspeed stack so the OKP URL is used, and mention RH_SERVER_OKP alongside the existing example environment variable export and references to localhost:8081; ensure any wording that says "SOLR_URL" is replaced with "RH_SERVER_OKP" (referencing the RH_SERVER_OKP env var and the OKP URL).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@docs/okp_guide.md`:
- Line 64: Update the note to reference the correct environment variable name:
replace SOLR_URL with RH_SERVER_OKP so it matches the rest of the doc and the
configuration examples (referencing okp.rhokp_url: ${env.RH_SERVER_OKP}); ensure
the note instructs users to set RH_SERVER_OKP to their OKP URL (e.g.,
http://localhost:8081) before launching Lightspeed stack.
---
Outside diff comments:
In `@docs/okp_guide.md`:
- Around line 45-46: Update the date-specific warning sentence that currently
reads "**Warning:** The image referenced below is a **prototype**. The official
OKP RAG image is expected in **late March / early April** of 2026." to a
non-time-specific phrasing (or remove the ETA) so it doesn't become stale;
locate that exact warning sentence in docs/okp_guide.md and replace the ETA
clause with a generic statement such as "The official OKP RAG image will be
released later; this is a prototype" or simply keep the prototype warning
without an expected date.
- Around line 49-75: The note incorrectly refers to SOLR_URL while the project
uses RH_SERVER_OKP; update the explanatory note to instruct users to set
RH_SERVER_OKP (not SOLR_URL) prior to launching the Lightspeed stack so the OKP
URL is used, and mention RH_SERVER_OKP alongside the existing example
environment variable export and references to localhost:8081; ensure any wording
that says "SOLR_URL" is replaced with "RH_SERVER_OKP" (referencing the
RH_SERVER_OKP env var and the OKP URL).
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: ASSERTIVE
Plan: Pro
Run ID: b2a9f007-bca0-43dd-b958-2942da960ba0
📒 Files selected for processing (1)
docs/okp_guide.md
📜 Review details
⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (12)
- GitHub Check: E2E Tests for Lightspeed Evaluation job
- GitHub Check: build-pr
- GitHub Check: Pylinter
- GitHub Check: E2E: server mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 2
- GitHub Check: E2E: library mode / ci / group 3
- GitHub Check: E2E: server mode / ci / group 3
- GitHub Check: E2E: library mode / ci / group 1
- GitHub Check: E2E: server mode / ci / group 1
- GitHub Check: unit_tests (3.12)
- GitHub Check: unit_tests (3.13)
- GitHub Check: Konflux kflux-prd-rh02 / lightspeed-stack-on-pull-request
🧰 Additional context used
🧠 Learnings (2)
📚 Learning: 2026-03-17T11:34:53.242Z
Learnt from: are-ces
Repo: lightspeed-core/lightspeed-stack PR: 1335
File: docs/config.md:411-411
Timestamp: 2026-03-17T11:34:53.242Z
Learning: In the lightspeed-stack project (`src/models/config.py`, `docs/config.md`), the internal Solr filter `is_chunk:true` (defined as `SOLR_CHUNK_FILTER_QUERY` in `src/constants.py`) is always injected by the system for OKP searches and is intentionally hidden from users. The `chunk_filter_query` field in `OkpConfiguration` is user-facing and additive-only, but the documentation must NOT mention the internal `is_chunk:true` behavior — this is a deliberate design decision by the maintainers.
Applied to files:
docs/okp_guide.md
📚 Learning: 2026-04-21T15:17:19.795Z
Learnt from: mwcz
Repo: lightspeed-core/lightspeed-stack PR: 1561
File: src/llama_stack_configuration.py:472-475
Timestamp: 2026-04-21T15:17:19.795Z
Learning: In the lightspeed-stack repository (src/llama_stack_configuration.py), the RHOKP internal Solr service is always located at the absolute path `/solr` on the host (e.g., `https://host/solr`). It is never at a subpath like `/okp/solr`. Therefore, using `urljoin(base_url, "/solr")` is intentional and correct — the absolute `/solr` path should not be changed to a relative segment.
Applied to files:
docs/okp_guide.md
🪛 LanguageTool
docs/okp_guide.md
[style] ~64-~64: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...vironment variable with the correct url prior to launching Lightspeed stack and that val...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
| Or visit: **http://localhost:8081** | ||
|
|
||
| > **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8983. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead. | ||
| > **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead. |
There was a problem hiding this comment.
Fix env var name on the “different OKP url” note (likely should be RH_SERVER_OKP, not SOLR_URL).
Line [64] says: “set the SOLR_URL environment variable…”. But the rest of this guide sets RH_SERVER_OKP (line [74]) and the config examples wire okp.rhokp_url: ${env.RH_SERVER_OKP} (lines [109] and [120]). If SOLR_URL isn’t actually supported by Lightspeed Stack, this will confuse users.
🛠️ Proposed fix
-If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead.
+If you need a different OKP url, you can set the `RH_SERVER_OKP` environment variable with the correct url before launching Lightspeed Stack, and that value will be used instead.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| > **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the SOLR_URL environment variable with the correct url prior to launching Lightspeed stack and that value will be used instead. | |
| > **Note:** Lightspeed stack will automatically enrich the llamastack configuration to add the necessary providers/resources for referencing OKP. This assumes your OKP instance is running on localhost:8081. If you need a different OKP url, you can set the `RH_SERVER_OKP` environment variable with the correct url before launching Lightspeed Stack, and that value will be used instead. |
🧰 Tools
🪛 LanguageTool
[style] ~64-~64: ‘prior to’ might be wordy. Consider a shorter alternative.
Context: ...vironment variable with the correct url prior to launching Lightspeed stack and that val...
(EN_WORDINESS_PREMIUM_PRIOR_TO)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/okp_guide.md` at line 64, Update the note to reference the correct
environment variable name: replace SOLR_URL with RH_SERVER_OKP so it matches the
rest of the doc and the configuration examples (referencing okp.rhokp_url:
${env.RH_SERVER_OKP}); ensure the note instructs users to set RH_SERVER_OKP to
their OKP URL (e.g., http://localhost:8081) before launching Lightspeed stack.
2 participants
Description
Update the OKP guide.
rhokp_urlfield, set to the standardRH_SERVER_OKPenv var.8983to8081.8983is suboptimal because that is the standard port for Apache Solr, but RHOKP != Solr. RHOKP does include a Solr server, but is not equivalent to it.8081avoids the conflict with LCORE's default of8080.Type of change
Tools used to create PR
Identify any AI code assistants used in this PR (for transparency and review context)
Related Tickets & Documents
Checklist before requesting a review
Testing
Documentation steps verified by setting up LCORE+OKP on a fresh machine.
Summary by CodeRabbit